package org.dromara.common.excel.annotation;

import java.lang.annotation.*;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：枚举格式化
 */
// 定义了注解的适用范围，仅用于成员变量
@Target({ElementType.FIELD})
// 注解的保留策略为运行时，即在运行时也可以获取到该注解
@Retention(RetentionPolicy.RUNTIME)
// 允许该注解被继承，即子类可以继承父类的该注解
@Inherited
public @interface ExcelEnumFormat {

    /**
     * 字典枚举类型
     */
    Class<? extends Enum<?>> enumClass();

    /**
     * 字典枚举类中对应的code属性名称，默认为code
     */
    String codeField() default "code";

    /**
     * 字典枚举类中对应的text属性名称，默认为text
     */
    String textField() default "text";

}
